home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / graphics / pstex / pstex.man < prev    next >
Text File  |  1992-01-27  |  6KB  |  199 lines
  1.  
  2.  
  3.  
  4. 8 September 1988                                         PSTEX(1)
  5.  
  6.  
  7.  
  8. NAME
  9.      pstex - convert LaTeX figures.
  10.  
  11. SYNOPSIS
  12.      pstex [ options ] file[.tex]
  13.  
  14. DESCRIPTION
  15.      _P_s_t_e_x is a BiBTeX-like processor for including figures into
  16.      LaTeX documents.  Figures are included using the ``\psbox''
  17.      macro; this macro causes LaTeX to make entries in the
  18.      ``.aux'' file(s) for the job.  _P_s_t_e_x finds these entries,
  19.      locates the corresponding PostScript files (which should be
  20.      in EPSF format as appropriate for _d_v_i_p_s), and determines how
  21.      to size the figure according to the options specified in the
  22.      macro in the LaTeX, and according to the nominal size and
  23.      shape of the PostScript.  It creates a ``.psz'' file con-
  24.      taining entries indicating the sizes which it has determined
  25.      to be appropriate for each figure.  When LaTeX starts up on
  26.      subsequent passes, this ``.psz'' file is read, and LaTeX is
  27.      then able to leave the correct amount of space for each fig-
  28.      ure as it encounters them in the text.
  29.  
  30.      The ``postscript'' macro file must be included in the list
  31.      of options in the documentstyle command.  This defines the
  32.      necessary macros.
  33.  
  34.      The primitive which is used by _p_s_t_e_x is
  35.      ``\postscriptbox{width}{height}{file}''.  This causes the
  36.      postscript of file.ps to be included into the document so
  37.      that its bounding box exactly fills the width and height
  38.      specified.  This creates a box, which is just like a charac-
  39.      ter, and can be placed anywhere in the document.  Typically
  40.      it is included within a figure environment and a center
  41.      environment, and is associated with a caption.
  42.  
  43.      The higher level macro which is provided by _p_s_t_e_x is
  44.      ``\psbox[options]{file}''.
  45.  
  46.      If the options string is omitted completely, the figure is
  47.      included at its natural, or design size, as specified in the
  48.      bounding box data of the PostScript.
  49.  
  50.      Combinations of four options can be specified, separated by
  51.      commas: _w_i_d_t_h=<_w_i_d_t_h>, _h_e_i_g_h_t=<_h_e_i_g_h_t>, _a_s_p_e_c_t=<_a_s_p_e_c_t>, and
  52.      _s_c_a_l_e=<_s_c_a_l_e> The keyword can be abbreviated, and spaces are
  53.      allowed.  The width and height options can be any valid TeX
  54.      or LaTeX which expands into a dimension when placed as the
  55.      argument to a setlength macro.  For example,
  56.      _w_i_d_t_h=\_c_o_l_u_m_n_w_i_d_t_h is a common specification.  The aspect
  57.      ratio and scale parameters must be floating point constants,
  58.      or must expand to such at the time the macro is first
  59.      invoked, for example _s_c_a_l_e=_0._7.
  60.  
  61.  
  62.  
  63.                                                                 1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. PSTEX(1)                                         8 September 1988
  71.  
  72.  
  73.  
  74.      If one of width or height is specified, the figure is scaled
  75.      to that size, keeping its natural aspect ratio, unless that
  76.      is overridden by the aspect parameter.
  77.  
  78.      If both of width and height are specified, the figure is
  79.      made to fit the specification exactly, if necessary changing
  80.      its aspect ratio.  In this mode, the aspect ratio parameter
  81.      is ignored.
  82.  
  83.      In any mode, the scale parameter multiplies all of the
  84.      dimensions.  This is especially useful to include a figure
  85.      at some fixed fraction of its natural size, specifying only
  86.      a scale factor in the options.
  87.  
  88.      Note that the dimensions can be TeX rubber dimensions so as
  89.      to fit into the page layout in the best possible manner, if
  90.      desired.
  91.  
  92. EXAMPLES
  93.      (Note that the slash characters below represent backslashes,
  94.      which are hard to include in troff text!)
  95.  
  96.      /_p_s_b_o_x{_f_i_l_e}
  97.           Include file.ps at natural size.
  98.  
  99.      /_p_s_b_o_x[_s=_0._7]{_f_i_l_e}
  100.           Include the document at natural size scaled down to
  101.           70%.
  102.  
  103.      /_p_s_b_o_x[_w=/_c_o_l_u_m_n_w_i_d_t_h, _s_c_a_l_e=/_m_y_d_o_c_s_c_a_l_e]{_f_i_l_e}
  104.           Stretch the figure to the width of the column, but
  105.           scale it down to /mydocscale (which might be defined as
  106.           0.9 for example).
  107.  
  108. OPTIONS
  109.      -z _p_s_d_i_r_s Specify different area for postscript files to be
  110.                included.  _P_s_d_i_r_s will be  searched for all
  111.                postscript files, instead of the path specified in
  112.                the environment variable.
  113.  
  114. ENVIRONMENT
  115.      DVIPSPATH A list of colon-separated directories where
  116.                PostScript files may be found for insertion.    It
  117.                defaults  to  ``:/usr/spar/font/ps''  which  means
  118.                that the current directory will be searched first
  119.                and then the default directory.
  120.  
  121. FILES
  122.      postscript.sty
  123.           Macro file defining the macros for LaTeX.
  124.  
  125.      jobname.aux
  126.  
  127.  
  128.  
  129. 2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. 8 September 1988                                         PSTEX(1)
  137.  
  138.  
  139.  
  140.           contains pointers to _p_s_t_e_x.
  141.  
  142.      file.ps
  143.           EPSF PostScript picture files.
  144.  
  145.      file.psz
  146.           File generated by _p_s_t_e_x and read in by LaTeX to afford
  147.           communication.
  148.  
  149. SEE ALSO
  150.      dvips(1), tex(1).
  151.  
  152. BUGS
  153.      LaTeX forces a cumbersome interface on its preprocessors,
  154.      such as BiBTeX and _p_s_t_e_x.  After adding a new figure, or
  155.      changing the specification in the LaTeX, you need to run
  156.      LaTeX, then _p_s_b_o_x, then LaTeX again to see the update
  157.      results.  After a change to the PostScript, only the final
  158.      LaTeX step is required.
  159.  
  160.      It is very hard to get troff to put in backslashes in the
  161.      documentation in all the right places.  Some are missing,
  162.      others are replaced by slashes.
  163.  
  164. AUTHOR
  165.      _P_s_t_e_x was written by Neil Hunt at Schlumberger Palo Alto
  166.      Research, now at Teleos Research: Neil%Teleos.com@ai.sri.com
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                 3
  196.  
  197.  
  198.  
  199.